Running CygNet Measurement Reports
CygNet Measurement includes a variety of industry-standard reports that can be run on an ad hoc or scheduled basis. All reports (except Normalization View reports, which display data in the time format inherited from the normalization view specified in the report template file), will display data in Device time (D). The command request is made relative to Contract time (C). The desired report can be run for any Node appropriate for the selected report command type.
Another use for CygNet Measurement reports is as the means to access data that has been archived out of the FMS database via Archive Data commands. Once measurement data has been archived off-site, run a CygNet Measurement report (not applicable to Balance or Missing Data report types) for the desired time period to access the archived data. See Archiving CygNet Measurement Data for more information.
Before you can run any CygNet Measurement report, a report template file (ReportTypeTemplate.xlsx) must exist in the CygNet\Services\FMS\ReportTemplates folder on your host server. The report template file contains desired report command and formatting information for the desired report type. See XLSX Functions Supported in CygNet Measurement Reports for information about what functions are supported by CygNet Measurement report grids.
To produce a CygNet Measurement report, execute a Reports: X command, with X representing the report type, to trigger the service to build the report as configured. The command references the specified report template file, and utilizes the parameters configured in the report definition sheet and the content information contained in the report sheet of the specified report template file. The report type is referenced from the report definition.
There are also some report functionality details that are helpful to consider when customizing your reports. See Using the Reports Control for more information.
See Managing Report Template Files for information about creating or editing FMS report template files.
See Managing Report Definitions for information about creating or editing FMS report definitions in FMS Explorer.
See Using the Reports Control for information about configuring and generating ad hoc reports through FMS Explorer.
See Scheduling FMS Command Tasks in the MSS for more information about configuring and generating scheduled reports through CygNet Explorer (MSS).
See FMS Commands for more information about commands and command parameters specific to each report type.
FMS Report Types
Each report type can be customized to accommodate desired content and formatting. The table below lists the industry-standard report types available in CygNet Measurement.
|
Report Category |
Report Type |
Report Template File Report Definition File |
Description |
|---|---|---|---|
|
Balance |
Command: |
Template: BalanceContributionTemplate.xlsx Definition: |
Reports balance contribution data for a defined time range, broken out for receipt (+) and delivery (-), showing volume, heating value volume, and energy values for:
Example Display the receipt and delivery values within a selected time window, for selected virtual station group Nodes and their member Nodes, including totals and averages, with results shown as one row per Node and one column per value type (volume, heating value volume, energy) Note: This report does not access archived data. |
|
Command: |
Template: Definition: |
Reports detailed balance data for a defined time range, by station (station meter and station group Nodes), showing volume, energy, and/or mass values Example Display the detailed balance values within a selected time window, by station, with results shown as one row per record span (e.g. hour, day, month) and one column per station Node data item (e.g. volume, energy, mass) Note: This report does not access archived data. |
|
|
Command: |
Template: Definition: |
Reports total balance data for the selected virtual station group Nodes (may contain physical station group, station meter, and/or liquid device Node members) and time range, showing volume, energy, or mass values Example Display total balance values for selected virtual station group Nodes, within a selected time window, with results shown as one row per record span (e.g. hour, day, month) Note: This report does not access archived data. |
|
|
Batch |
Command: |
Template: Definition: |
Reports batch records for the selected liquid device Node(s) and time range Example Display data item values per batch record within a selected time window, for each selected liquid device Node (supporting batch data) Note: This report can access archived data. |
|
Changed Data |
Command: |
Template: Definition: |
Reports changes made to gas metering, gas quality, or liquid periodic metering data records for the selected device Node(s) and time range Example Display changes made by editing or re-polling data, for selected device Node(s), displayed for each data item that changed within the selected time window Note: This report can access archived data. |
|
Command: |
Template: Definition: |
Reports changes made to gas metering or gas quality data records for the selected gas station Nodes and time range Example Display changes made by editing or re-polling data, for selected station meter or station group Node(s), displayed for each data item that changed within the selected time window Note: This report can access archived data. |
|
|
Configuration |
Command: |
Template: Definition: |
Reports configured values of measurement constants, and any value changes, for the selected Node(s) and time range Example Display configuration value changes per device Node, for all devices of a specified type, within a selected time window Note: This report can access archived data. |
|
Command: |
Template: Definition: |
Reports information and component values from gas analysis data, for the selected Node(s) and time range Example Display gas analysis values per device Node, for all devices selected, within a selected time window Note: This report can access archived data. |
|
|
Device QTR (Quantity Transaction Record) |
Command: |
Template: Definition: |
Reports total values for the defined time range Example Display total volume data within a selected time window, based on device data totals, with results shown in one row per gas device Node Note: This report can access archived data. |
|
Command: |
Template: Definition: |
Reports daily values for the selected gas device Node and time range Example Display daily volume data per gas device Node, within a selected time window, with results shown in one row per device record span (e.g. hour) Note: This report can access archived data. |
|
|
Command: |
Template: Definition: |
Reports raw values for the selected gas device Node and time range Example Display raw data received per gas device Node, within a selected time window Note: This report can access archived data. |
|
|
Command: |
Template: Definition: |
Reports daily values for the selected liquid device Node and time range Example Display daily volume data per liquid device Node, within a selected time window, with results shown in one row per device record span (e.g. hour) Note: This report can access archived data. |
|
|
Command: |
Template: Definition: |
Reports raw values for the selected liquid device Node and time range Example Display raw data received per liquid device Node, within a selected time window Note: This report can access archived data. |
|
|
Event |
Command: |
Template: Definition: |
Reports events and audit information for the selected Node(s) and time range Example Display event data per group Node, displayed for each group within a selected time window Note: This report can access archived data. |
|
Job |
Command: |
Template: Or, to use automatic calibration rows: JobTemplateAuto.xlsx Definition: |
Note: This report is provided for use with CygNet Dispatch. For more information about the CygNet Dispatch product, contact your Account Manager or CygNet Sales. Reports job information for the selected Node(s) and time range; a variant template is also provided to use to automatically populate certain calibration rows for DP, SP, or Temp values Example Display job details (e.g. calibration jobs, gas sample jobs) for a group or device Node, displayed for a selected time Note: This report can access archived data. |
|
Command: |
Template: Definition: |
Note: This report is provided for use with CygNet Dispatch. For more information about the CygNet Dispatch product, contact your Account Manager or CygNet Sales. Reports late job information associated with the selected Node and time range Example Display a list of jobs of defined types (e.g. calibration jobs, gas sample jobs) for a group or device Node, to identify jobs that are currently late or could soon be late (past or approaching the "required by" date) |
|
|
Missing Data |
Command: |
Template: Definition: |
Reports detailed data collection status for the selected Nodes and time range, showing what types of data records are missing Example Display the number of missing records for each Node, by data type, within a selected time window Note: This report does not access archived data. |
|
Command: |
Template: MissingDataOverviewTemplate.xlsx Definition: |
Reports a synopsis of daily data collection status for the selected Nodes and time range, showing where there is incomplete or missing data Example Display the daily records status for each Node, indicating if data is complete, incomplete or missing, within a selected time window Note: This report does not access archived data. |
|
|
Normalization View |
Command: |
Template: NormalizationViewTemplate.xlsx Definition: |
Reports a view of normalized data for a defined time range Example Display data values using a selected normalization view for all data displayed within a selected time window Note: This report can access archived data. |
|
Ticket |
Command: |
Template: Definition: |
Reports ticket records for the selected liquid device Node(s) and time range Example Display data item values per ticket record within a selected time window, for each selected liquid device Node (supporting ticket data) Note: This report can access archived data. |
Running Ad Hoc FMS Reports
Reports can be run on an ad hoc basis through the Reports control in FMS Explorer.
See Using the Reports Control for more information about configuring and generating ad hoc FMS reports.
Running Scheduled FMS Reports
Reports can be run on a scheduled basis through the MSS (Master Scheduling Service) in CygNet Explorer, in the same manner used to schedule other FMS commands.
See Scheduling FMS Command Tasks in the MSS for more information about configuring and generating scheduled FMS reports.
As part of the process, you can arrange to email scheduled reports from the CygNet Measurement system using the Email distribution list parameter for the selected report type.
See the corresponding Reports: X topic in the FMS Commands section for more information about configuring the Email distribution list parameter.
See Configuring Email Options for more information about configuring or editing authentication and options for emailing reports from your measurement system.
Handling of Empty Data Cells in FMS Reports
Reports may have data cells without values (null or missing data value) for a specific record. Cells with null values are handled differently, depending on column value types. For columns with string values, these null values will be accounted for in aggregations of data. For columns with numeric values, these null values will be ignored.
More:
Managing Report Template Files
Supported Functions in Report Template Files
